<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="SequenceRunner,net.digitalprimates.fluint.sequence.SequenceRunner,numberOfSteps,addAssertHandler,addStep,continueSequence,getExecutingStep,getPendingStep,getStep,run" name="keywords">
<title>net.digitalprimates.fluint.sequence.SequenceRunner</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'SequenceRunner - Fluint API';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?net/digitalprimates/fluint/sequence/SequenceRunner.html&amp;net/digitalprimates/fluint/sequence/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;SequenceRunner</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class SequenceRunner"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">net.digitalprimates.fluint.sequence</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class SequenceRunner</td>
</tr>
</table>
<p></p>
     Allows developer to add a series of steps, execute those steps 
  in order, until the sequence is complete.
     <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#numberOfSteps">numberOfSteps</a> : int<div class="summaryTableDescription">[read-only]
   Returns number of steps in the sequence.</div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#SequenceRunner()">SequenceRunner</a>(testCase:<a href="../tests/TestCase.html">TestCase</a>)</div>
<div class="summaryTableDescription">
   Constructor.</div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addAssertHandler()">addAssertHandler</a>(assertHandler:Function, passThroughData:Object):void</div>
<div class="summaryTableDescription"> 
    <p>
    Add a reference to the event handler that should be called if the sequence completes 
    sucessfully.</p>
    
    <p>
    The handler is expected to have the follow signature:</p>
    
    <p>
    <code>public function handleEvent( event:Event, passThroughData:Object ):void {
    }</code></p>
    
   </div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addStep()">addStep</a>(step:<a href="ISequenceStep.html">ISequenceStep</a>):void</div>
<div class="summaryTableDescription">
   Adds an ISequenceStep to the sequence.</div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#continueSequence()">continueSequence</a>(event:Event):void</div>
<div class="summaryTableDescription">
   Called by the testCase when the next step in the sequence should begin.</div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getExecutingStep()">getExecutingStep</a>():<a href="../sequence/ISequenceStep.html">ISequenceStep</a>
</div>
<div class="summaryTableDescription">
   Returns the ISequenceStep currently executing.</div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getPendingStep()">getPendingStep</a>():<a href="../sequence/ISequencePend.html">ISequencePend</a>
</div>
<div class="summaryTableDescription">
   Returns the ISequenceStep currently executing.</div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getStep()">getStep</a>(stepIndex:int):<a href="../sequence/ISequenceStep.html">ISequenceStep</a>
</div>
<div class="summaryTableDescription">
   Returns the ISequenceStep at a specified index.</div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#run()">run</a>():void</div>
<div class="summaryTableDescription">
   Begins the execution of a sequence.</div>
</td><td class="summaryTableOwnerCol">SequenceRunner</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="numberOfSteps"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">numberOfSteps</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>numberOfSteps:int</code>&nbsp;&nbsp;[read-only]<p>
   Returns number of steps in the sequence.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get numberOfSteps():int</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="SequenceRunner()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">SequenceRunner</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function SequenceRunner(testCase:<a href="../tests/TestCase.html">TestCase</a>)</code><p>
   Constructor.
    
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">testCase</span>:<a href="../tests/TestCase.html">TestCase</a></code> &mdash; testCase within which is sequence is being run.
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addAssertHandler()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addAssertHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function addAssertHandler(assertHandler:Function, passThroughData:Object):void</code><p> 
    </p><p>
    Add a reference to the event handler that should be called if the sequence completes 
    sucessfully.</p>
    
    <p>
    The handler is expected to have the follow signature:</p>
    
    <p>
    <code>public function handleEvent( event:Event, passThroughData:Object ):void {
    }</code></p>
    
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">assertHandler</span>:Function</code> &mdash; The original event object from the previous step.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">passThroughData</span>:Object</code> &mdash; A generic object that can optionally be provided by 
    the developer when creating a new sequence.
   </td>
</tr>
</table>
</div>
<a name="addStep()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addStep</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function addStep(step:<a href="ISequenceStep.html">ISequenceStep</a>):void</code><p>
   Adds an ISequenceStep to the sequence.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">step</span>:<a href="ISequenceStep.html">ISequenceStep</a></code> &mdash; Step to be added.
   </td>
</tr>
</table>
</div>
<a name="continueSequence()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">continueSequence</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function continueSequence(event:Event):void</code><p>
   Called by the testCase when the next step in the sequence should begin.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">event</span>:Event</code> &mdash; Event broadcast by the last step in the sequence.
   </td>
</tr>
</table>
</div>
<a name="getExecutingStep()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getExecutingStep</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getExecutingStep():<a href="../sequence/ISequenceStep.html">ISequenceStep</a></code><p>
   Returns the ISequenceStep currently executing.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../sequence/ISequenceStep.html">ISequenceStep</a></code></td>
</tr>
</table>
</div>
<a name="getPendingStep()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getPendingStep</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getPendingStep():<a href="../sequence/ISequencePend.html">ISequencePend</a></code><p>
   Returns the ISequenceStep currently executing.
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../sequence/ISequencePend.html">ISequencePend</a></code></td>
</tr>
</table>
</div>
<a name="getStep()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getStep</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getStep(stepIndex:int):<a href="../sequence/ISequenceStep.html">ISequenceStep</a></code><p>
   Returns the ISequenceStep at a specified index.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">stepIndex</span>:int</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../sequence/ISequenceStep.html">ISequenceStep</a></code></td>
</tr>
</table>
</div>
<a name="run()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">run</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function run():void</code><p>
   Begins the execution of a sequence.
   </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
